<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     * <a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     * <a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.lang3;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.io.IOException;<a name="line.19"></a>
<FONT color="green">020</FONT>    import java.io.Writer;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    import org.apache.commons.lang3.text.translate.AggregateTranslator;<a name="line.22"></a>
<FONT color="green">023</FONT>    import org.apache.commons.lang3.text.translate.CharSequenceTranslator;<a name="line.23"></a>
<FONT color="green">024</FONT>    import org.apache.commons.lang3.text.translate.EntityArrays;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.apache.commons.lang3.text.translate.LookupTranslator;<a name="line.25"></a>
<FONT color="green">026</FONT>    import org.apache.commons.lang3.text.translate.NumericEntityUnescaper;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.apache.commons.lang3.text.translate.OctalUnescaper;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.apache.commons.lang3.text.translate.UnicodeEscaper;<a name="line.28"></a>
<FONT color="green">029</FONT>    import org.apache.commons.lang3.text.translate.UnicodeUnescaper;<a name="line.29"></a>
<FONT color="green">030</FONT>    <a name="line.30"></a>
<FONT color="green">031</FONT>    /**<a name="line.31"></a>
<FONT color="green">032</FONT>     * &lt;p&gt;Escapes and unescapes {@code String}s for<a name="line.32"></a>
<FONT color="green">033</FONT>     * Java, Java Script, HTML and XML.&lt;/p&gt;<a name="line.33"></a>
<FONT color="green">034</FONT>     *<a name="line.34"></a>
<FONT color="green">035</FONT>     * &lt;p&gt;#ThreadSafe#&lt;/p&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>     * @since 2.0<a name="line.36"></a>
<FONT color="green">037</FONT>     * @version $Id: StringEscapeUtils.java 1148520 2011-07-19 20:53:23Z ggregory $<a name="line.37"></a>
<FONT color="green">038</FONT>     */<a name="line.38"></a>
<FONT color="green">039</FONT>    public class StringEscapeUtils {<a name="line.39"></a>
<FONT color="green">040</FONT>    <a name="line.40"></a>
<FONT color="green">041</FONT>        /* ESCAPE TRANSLATORS */<a name="line.41"></a>
<FONT color="green">042</FONT>    <a name="line.42"></a>
<FONT color="green">043</FONT>        /**<a name="line.43"></a>
<FONT color="green">044</FONT>         * Translator object for escaping Java. <a name="line.44"></a>
<FONT color="green">045</FONT>         * <a name="line.45"></a>
<FONT color="green">046</FONT>         * While {@link #escapeJava(String)} is the expected method of use, this <a name="line.46"></a>
<FONT color="green">047</FONT>         * object allows the Java escaping functionality to be used <a name="line.47"></a>
<FONT color="green">048</FONT>         * as the foundation for a custom translator. <a name="line.48"></a>
<FONT color="green">049</FONT>         *<a name="line.49"></a>
<FONT color="green">050</FONT>         * @since 3.0<a name="line.50"></a>
<FONT color="green">051</FONT>         */<a name="line.51"></a>
<FONT color="green">052</FONT>        public static final CharSequenceTranslator ESCAPE_JAVA = <a name="line.52"></a>
<FONT color="green">053</FONT>              new LookupTranslator(<a name="line.53"></a>
<FONT color="green">054</FONT>                new String[][] { <a name="line.54"></a>
<FONT color="green">055</FONT>                  {"\"", "\\\""},<a name="line.55"></a>
<FONT color="green">056</FONT>                  {"\\", "\\\\"},<a name="line.56"></a>
<FONT color="green">057</FONT>              }).with(<a name="line.57"></a>
<FONT color="green">058</FONT>                new LookupTranslator(EntityArrays.JAVA_CTRL_CHARS_ESCAPE())<a name="line.58"></a>
<FONT color="green">059</FONT>              ).with(<a name="line.59"></a>
<FONT color="green">060</FONT>                UnicodeEscaper.outsideOf(32, 0x7f) <a name="line.60"></a>
<FONT color="green">061</FONT>            );<a name="line.61"></a>
<FONT color="green">062</FONT>    <a name="line.62"></a>
<FONT color="green">063</FONT>        /**<a name="line.63"></a>
<FONT color="green">064</FONT>         * Translator object for escaping EcmaScript/JavaScript. <a name="line.64"></a>
<FONT color="green">065</FONT>         * <a name="line.65"></a>
<FONT color="green">066</FONT>         * While {@link #escapeEcmaScript(String)} is the expected method of use, this <a name="line.66"></a>
<FONT color="green">067</FONT>         * object allows the EcmaScript escaping functionality to be used <a name="line.67"></a>
<FONT color="green">068</FONT>         * as the foundation for a custom translator. <a name="line.68"></a>
<FONT color="green">069</FONT>         *<a name="line.69"></a>
<FONT color="green">070</FONT>         * @since 3.0<a name="line.70"></a>
<FONT color="green">071</FONT>         */<a name="line.71"></a>
<FONT color="green">072</FONT>        public static final CharSequenceTranslator ESCAPE_ECMASCRIPT = <a name="line.72"></a>
<FONT color="green">073</FONT>            new AggregateTranslator(<a name="line.73"></a>
<FONT color="green">074</FONT>                new LookupTranslator(<a name="line.74"></a>
<FONT color="green">075</FONT>                          new String[][] { <a name="line.75"></a>
<FONT color="green">076</FONT>                                {"'", "\\'"},<a name="line.76"></a>
<FONT color="green">077</FONT>                                {"\"", "\\\""},<a name="line.77"></a>
<FONT color="green">078</FONT>                                {"\\", "\\\\"},<a name="line.78"></a>
<FONT color="green">079</FONT>                                {"/", "\\/"}<a name="line.79"></a>
<FONT color="green">080</FONT>                          }),<a name="line.80"></a>
<FONT color="green">081</FONT>                new LookupTranslator(EntityArrays.JAVA_CTRL_CHARS_ESCAPE()),<a name="line.81"></a>
<FONT color="green">082</FONT>                UnicodeEscaper.outsideOf(32, 0x7f) <a name="line.82"></a>
<FONT color="green">083</FONT>            );<a name="line.83"></a>
<FONT color="green">084</FONT>                <a name="line.84"></a>
<FONT color="green">085</FONT>        /**<a name="line.85"></a>
<FONT color="green">086</FONT>         * Translator object for escaping XML.<a name="line.86"></a>
<FONT color="green">087</FONT>         * <a name="line.87"></a>
<FONT color="green">088</FONT>         * While {@link #escapeXml(String)} is the expected method of use, this <a name="line.88"></a>
<FONT color="green">089</FONT>         * object allows the XML escaping functionality to be used <a name="line.89"></a>
<FONT color="green">090</FONT>         * as the foundation for a custom translator. <a name="line.90"></a>
<FONT color="green">091</FONT>         *<a name="line.91"></a>
<FONT color="green">092</FONT>         * @since 3.0<a name="line.92"></a>
<FONT color="green">093</FONT>         */<a name="line.93"></a>
<FONT color="green">094</FONT>        public static final CharSequenceTranslator ESCAPE_XML = <a name="line.94"></a>
<FONT color="green">095</FONT>            new AggregateTranslator(<a name="line.95"></a>
<FONT color="green">096</FONT>                new LookupTranslator(EntityArrays.BASIC_ESCAPE()),<a name="line.96"></a>
<FONT color="green">097</FONT>                new LookupTranslator(EntityArrays.APOS_ESCAPE())<a name="line.97"></a>
<FONT color="green">098</FONT>            );<a name="line.98"></a>
<FONT color="green">099</FONT>    <a name="line.99"></a>
<FONT color="green">100</FONT>        /**<a name="line.100"></a>
<FONT color="green">101</FONT>         * Translator object for escaping HTML version 3.0.<a name="line.101"></a>
<FONT color="green">102</FONT>         * <a name="line.102"></a>
<FONT color="green">103</FONT>         * While {@link #escapeHtml3(String)} is the expected method of use, this <a name="line.103"></a>
<FONT color="green">104</FONT>         * object allows the HTML escaping functionality to be used <a name="line.104"></a>
<FONT color="green">105</FONT>         * as the foundation for a custom translator. <a name="line.105"></a>
<FONT color="green">106</FONT>         *<a name="line.106"></a>
<FONT color="green">107</FONT>         * @since 3.0<a name="line.107"></a>
<FONT color="green">108</FONT>         */<a name="line.108"></a>
<FONT color="green">109</FONT>        public static final CharSequenceTranslator ESCAPE_HTML3 = <a name="line.109"></a>
<FONT color="green">110</FONT>            new AggregateTranslator(<a name="line.110"></a>
<FONT color="green">111</FONT>                new LookupTranslator(EntityArrays.BASIC_ESCAPE()),<a name="line.111"></a>
<FONT color="green">112</FONT>                new LookupTranslator(EntityArrays.ISO8859_1_ESCAPE())<a name="line.112"></a>
<FONT color="green">113</FONT>            );<a name="line.113"></a>
<FONT color="green">114</FONT>    <a name="line.114"></a>
<FONT color="green">115</FONT>        /**<a name="line.115"></a>
<FONT color="green">116</FONT>         * Translator object for escaping HTML version 4.0.<a name="line.116"></a>
<FONT color="green">117</FONT>         * <a name="line.117"></a>
<FONT color="green">118</FONT>         * While {@link #escapeHtml4(String)} is the expected method of use, this <a name="line.118"></a>
<FONT color="green">119</FONT>         * object allows the HTML escaping functionality to be used <a name="line.119"></a>
<FONT color="green">120</FONT>         * as the foundation for a custom translator. <a name="line.120"></a>
<FONT color="green">121</FONT>         *<a name="line.121"></a>
<FONT color="green">122</FONT>         * @since 3.0<a name="line.122"></a>
<FONT color="green">123</FONT>         */<a name="line.123"></a>
<FONT color="green">124</FONT>        public static final CharSequenceTranslator ESCAPE_HTML4 = <a name="line.124"></a>
<FONT color="green">125</FONT>            new AggregateTranslator(<a name="line.125"></a>
<FONT color="green">126</FONT>                new LookupTranslator(EntityArrays.BASIC_ESCAPE()),<a name="line.126"></a>
<FONT color="green">127</FONT>                new LookupTranslator(EntityArrays.ISO8859_1_ESCAPE()),<a name="line.127"></a>
<FONT color="green">128</FONT>                new LookupTranslator(EntityArrays.HTML40_EXTENDED_ESCAPE())<a name="line.128"></a>
<FONT color="green">129</FONT>            );<a name="line.129"></a>
<FONT color="green">130</FONT>    <a name="line.130"></a>
<FONT color="green">131</FONT>        /**<a name="line.131"></a>
<FONT color="green">132</FONT>         * Translator object for escaping individual Comma Separated Values. <a name="line.132"></a>
<FONT color="green">133</FONT>         * <a name="line.133"></a>
<FONT color="green">134</FONT>         * While {@link #escapeCsv(String)} is the expected method of use, this <a name="line.134"></a>
<FONT color="green">135</FONT>         * object allows the CSV escaping functionality to be used <a name="line.135"></a>
<FONT color="green">136</FONT>         * as the foundation for a custom translator. <a name="line.136"></a>
<FONT color="green">137</FONT>         *<a name="line.137"></a>
<FONT color="green">138</FONT>         * @since 3.0<a name="line.138"></a>
<FONT color="green">139</FONT>         */<a name="line.139"></a>
<FONT color="green">140</FONT>        public static final CharSequenceTranslator ESCAPE_CSV = new CsvEscaper();<a name="line.140"></a>
<FONT color="green">141</FONT>    <a name="line.141"></a>
<FONT color="green">142</FONT>        // TODO: Create a parent class - 'SinglePassTranslator' ?<a name="line.142"></a>
<FONT color="green">143</FONT>        //       It would handle the index checking + length returning, <a name="line.143"></a>
<FONT color="green">144</FONT>        //       and could also have an optimization check method.<a name="line.144"></a>
<FONT color="green">145</FONT>        static class CsvEscaper extends CharSequenceTranslator {<a name="line.145"></a>
<FONT color="green">146</FONT>    <a name="line.146"></a>
<FONT color="green">147</FONT>            private static final char CSV_DELIMITER = ',';<a name="line.147"></a>
<FONT color="green">148</FONT>            private static final char CSV_QUOTE = '"';<a name="line.148"></a>
<FONT color="green">149</FONT>            private static final String CSV_QUOTE_STR = String.valueOf(CSV_QUOTE);<a name="line.149"></a>
<FONT color="green">150</FONT>            private static final char[] CSV_SEARCH_CHARS = <a name="line.150"></a>
<FONT color="green">151</FONT>                new char[] {CSV_DELIMITER, CSV_QUOTE, CharUtils.CR, CharUtils.LF};<a name="line.151"></a>
<FONT color="green">152</FONT>    <a name="line.152"></a>
<FONT color="green">153</FONT>            @Override<a name="line.153"></a>
<FONT color="green">154</FONT>            public int translate(CharSequence input, int index, Writer out) throws IOException {<a name="line.154"></a>
<FONT color="green">155</FONT>    <a name="line.155"></a>
<FONT color="green">156</FONT>                if(index != 0) {<a name="line.156"></a>
<FONT color="green">157</FONT>                    throw new IllegalStateException("CsvEscaper should never reach the [1] index");<a name="line.157"></a>
<FONT color="green">158</FONT>                }<a name="line.158"></a>
<FONT color="green">159</FONT>    <a name="line.159"></a>
<FONT color="green">160</FONT>                if (StringUtils.containsNone(input.toString(), CSV_SEARCH_CHARS)) {<a name="line.160"></a>
<FONT color="green">161</FONT>                    out.write(input.toString());<a name="line.161"></a>
<FONT color="green">162</FONT>                } else {<a name="line.162"></a>
<FONT color="green">163</FONT>                    out.write(CSV_QUOTE);<a name="line.163"></a>
<FONT color="green">164</FONT>                    out.write(StringUtils.replace(input.toString(), CSV_QUOTE_STR, CSV_QUOTE_STR + CSV_QUOTE_STR));<a name="line.164"></a>
<FONT color="green">165</FONT>                    out.write(CSV_QUOTE);<a name="line.165"></a>
<FONT color="green">166</FONT>                }<a name="line.166"></a>
<FONT color="green">167</FONT>                return input.length();<a name="line.167"></a>
<FONT color="green">168</FONT>            }<a name="line.168"></a>
<FONT color="green">169</FONT>        }<a name="line.169"></a>
<FONT color="green">170</FONT>    <a name="line.170"></a>
<FONT color="green">171</FONT>        /* UNESCAPE TRANSLATORS */<a name="line.171"></a>
<FONT color="green">172</FONT>    <a name="line.172"></a>
<FONT color="green">173</FONT>        /**<a name="line.173"></a>
<FONT color="green">174</FONT>         * Translator object for unescaping escaped Java. <a name="line.174"></a>
<FONT color="green">175</FONT>         * <a name="line.175"></a>
<FONT color="green">176</FONT>         * While {@link #unescapeJava(String)} is the expected method of use, this <a name="line.176"></a>
<FONT color="green">177</FONT>         * object allows the Java unescaping functionality to be used <a name="line.177"></a>
<FONT color="green">178</FONT>         * as the foundation for a custom translator. <a name="line.178"></a>
<FONT color="green">179</FONT>         *<a name="line.179"></a>
<FONT color="green">180</FONT>         * @since 3.0<a name="line.180"></a>
<FONT color="green">181</FONT>         */<a name="line.181"></a>
<FONT color="green">182</FONT>        // TODO: throw "illegal character: \92" as an Exception if a \ on the end of the Java (as per the compiler)?<a name="line.182"></a>
<FONT color="green">183</FONT>        public static final CharSequenceTranslator UNESCAPE_JAVA = <a name="line.183"></a>
<FONT color="green">184</FONT>            new AggregateTranslator(<a name="line.184"></a>
<FONT color="green">185</FONT>                new OctalUnescaper(),     // .between('\1', '\377'),<a name="line.185"></a>
<FONT color="green">186</FONT>                new UnicodeUnescaper(),<a name="line.186"></a>
<FONT color="green">187</FONT>                new LookupTranslator(EntityArrays.JAVA_CTRL_CHARS_UNESCAPE()),<a name="line.187"></a>
<FONT color="green">188</FONT>                new LookupTranslator(<a name="line.188"></a>
<FONT color="green">189</FONT>                          new String[][] { <a name="line.189"></a>
<FONT color="green">190</FONT>                                {"\\\\", "\\"},<a name="line.190"></a>
<FONT color="green">191</FONT>                                {"\\\"", "\""},<a name="line.191"></a>
<FONT color="green">192</FONT>                                {"\\'", "'"},<a name="line.192"></a>
<FONT color="green">193</FONT>                                {"\\", ""}<a name="line.193"></a>
<FONT color="green">194</FONT>                          })<a name="line.194"></a>
<FONT color="green">195</FONT>            );<a name="line.195"></a>
<FONT color="green">196</FONT>    <a name="line.196"></a>
<FONT color="green">197</FONT>        /**<a name="line.197"></a>
<FONT color="green">198</FONT>         * Translator object for unescaping escaped EcmaScript. <a name="line.198"></a>
<FONT color="green">199</FONT>         * <a name="line.199"></a>
<FONT color="green">200</FONT>         * While {@link #unescapeEcmaScript(String)} is the expected method of use, this <a name="line.200"></a>
<FONT color="green">201</FONT>         * object allows the EcmaScript unescaping functionality to be used <a name="line.201"></a>
<FONT color="green">202</FONT>         * as the foundation for a custom translator. <a name="line.202"></a>
<FONT color="green">203</FONT>         *<a name="line.203"></a>
<FONT color="green">204</FONT>         * @since 3.0<a name="line.204"></a>
<FONT color="green">205</FONT>         */<a name="line.205"></a>
<FONT color="green">206</FONT>        public static final CharSequenceTranslator UNESCAPE_ECMASCRIPT = UNESCAPE_JAVA;<a name="line.206"></a>
<FONT color="green">207</FONT>    <a name="line.207"></a>
<FONT color="green">208</FONT>        /**<a name="line.208"></a>
<FONT color="green">209</FONT>         * Translator object for unescaping escaped HTML 3.0. <a name="line.209"></a>
<FONT color="green">210</FONT>         * <a name="line.210"></a>
<FONT color="green">211</FONT>         * While {@link #unescapeHtml3(String)} is the expected method of use, this <a name="line.211"></a>
<FONT color="green">212</FONT>         * object allows the HTML unescaping functionality to be used <a name="line.212"></a>
<FONT color="green">213</FONT>         * as the foundation for a custom translator. <a name="line.213"></a>
<FONT color="green">214</FONT>         *<a name="line.214"></a>
<FONT color="green">215</FONT>         * @since 3.0<a name="line.215"></a>
<FONT color="green">216</FONT>         */<a name="line.216"></a>
<FONT color="green">217</FONT>        public static final CharSequenceTranslator UNESCAPE_HTML3 = <a name="line.217"></a>
<FONT color="green">218</FONT>            new AggregateTranslator(<a name="line.218"></a>
<FONT color="green">219</FONT>                new LookupTranslator(EntityArrays.BASIC_UNESCAPE()),<a name="line.219"></a>
<FONT color="green">220</FONT>                new LookupTranslator(EntityArrays.ISO8859_1_UNESCAPE()),<a name="line.220"></a>
<FONT color="green">221</FONT>                new NumericEntityUnescaper()<a name="line.221"></a>
<FONT color="green">222</FONT>            );<a name="line.222"></a>
<FONT color="green">223</FONT>    <a name="line.223"></a>
<FONT color="green">224</FONT>        /**<a name="line.224"></a>
<FONT color="green">225</FONT>         * Translator object for unescaping escaped HTML 4.0. <a name="line.225"></a>
<FONT color="green">226</FONT>         * <a name="line.226"></a>
<FONT color="green">227</FONT>         * While {@link #unescapeHtml4(String)} is the expected method of use, this <a name="line.227"></a>
<FONT color="green">228</FONT>         * object allows the HTML unescaping functionality to be used <a name="line.228"></a>
<FONT color="green">229</FONT>         * as the foundation for a custom translator. <a name="line.229"></a>
<FONT color="green">230</FONT>         *<a name="line.230"></a>
<FONT color="green">231</FONT>         * @since 3.0<a name="line.231"></a>
<FONT color="green">232</FONT>         */<a name="line.232"></a>
<FONT color="green">233</FONT>        public static final CharSequenceTranslator UNESCAPE_HTML4 = <a name="line.233"></a>
<FONT color="green">234</FONT>            new AggregateTranslator(<a name="line.234"></a>
<FONT color="green">235</FONT>                new LookupTranslator(EntityArrays.BASIC_UNESCAPE()),<a name="line.235"></a>
<FONT color="green">236</FONT>                new LookupTranslator(EntityArrays.ISO8859_1_UNESCAPE()),<a name="line.236"></a>
<FONT color="green">237</FONT>                new LookupTranslator(EntityArrays.HTML40_EXTENDED_UNESCAPE()),<a name="line.237"></a>
<FONT color="green">238</FONT>                new NumericEntityUnescaper()<a name="line.238"></a>
<FONT color="green">239</FONT>            );<a name="line.239"></a>
<FONT color="green">240</FONT>    <a name="line.240"></a>
<FONT color="green">241</FONT>        /**<a name="line.241"></a>
<FONT color="green">242</FONT>         * Translator object for unescaping escaped XML.<a name="line.242"></a>
<FONT color="green">243</FONT>         * <a name="line.243"></a>
<FONT color="green">244</FONT>         * While {@link #unescapeXml(String)} is the expected method of use, this <a name="line.244"></a>
<FONT color="green">245</FONT>         * object allows the XML unescaping functionality to be used <a name="line.245"></a>
<FONT color="green">246</FONT>         * as the foundation for a custom translator. <a name="line.246"></a>
<FONT color="green">247</FONT>         *<a name="line.247"></a>
<FONT color="green">248</FONT>         * @since 3.0<a name="line.248"></a>
<FONT color="green">249</FONT>         */<a name="line.249"></a>
<FONT color="green">250</FONT>        public static final CharSequenceTranslator UNESCAPE_XML = <a name="line.250"></a>
<FONT color="green">251</FONT>            new AggregateTranslator(<a name="line.251"></a>
<FONT color="green">252</FONT>                new LookupTranslator(EntityArrays.BASIC_UNESCAPE()),<a name="line.252"></a>
<FONT color="green">253</FONT>                new LookupTranslator(EntityArrays.APOS_UNESCAPE()),<a name="line.253"></a>
<FONT color="green">254</FONT>                new NumericEntityUnescaper()<a name="line.254"></a>
<FONT color="green">255</FONT>            );<a name="line.255"></a>
<FONT color="green">256</FONT>    <a name="line.256"></a>
<FONT color="green">257</FONT>        /**<a name="line.257"></a>
<FONT color="green">258</FONT>         * Translator object for unescaping escaped Comma Separated Value entries.<a name="line.258"></a>
<FONT color="green">259</FONT>         * <a name="line.259"></a>
<FONT color="green">260</FONT>         * While {@link #unescapeCsv(String)} is the expected method of use, this <a name="line.260"></a>
<FONT color="green">261</FONT>         * object allows the CSV unescaping functionality to be used <a name="line.261"></a>
<FONT color="green">262</FONT>         * as the foundation for a custom translator. <a name="line.262"></a>
<FONT color="green">263</FONT>         *<a name="line.263"></a>
<FONT color="green">264</FONT>         * @since 3.0<a name="line.264"></a>
<FONT color="green">265</FONT>         */<a name="line.265"></a>
<FONT color="green">266</FONT>        public static final CharSequenceTranslator UNESCAPE_CSV = new CsvUnescaper();<a name="line.266"></a>
<FONT color="green">267</FONT>    <a name="line.267"></a>
<FONT color="green">268</FONT>        static class CsvUnescaper extends CharSequenceTranslator {<a name="line.268"></a>
<FONT color="green">269</FONT>    <a name="line.269"></a>
<FONT color="green">270</FONT>            private static final char CSV_DELIMITER = ',';<a name="line.270"></a>
<FONT color="green">271</FONT>            private static final char CSV_QUOTE = '"';<a name="line.271"></a>
<FONT color="green">272</FONT>            private static final String CSV_QUOTE_STR = String.valueOf(CSV_QUOTE);<a name="line.272"></a>
<FONT color="green">273</FONT>            private static final char[] CSV_SEARCH_CHARS = <a name="line.273"></a>
<FONT color="green">274</FONT>                new char[] {CSV_DELIMITER, CSV_QUOTE, CharUtils.CR, CharUtils.LF};<a name="line.274"></a>
<FONT color="green">275</FONT>    <a name="line.275"></a>
<FONT color="green">276</FONT>            @Override<a name="line.276"></a>
<FONT color="green">277</FONT>            public int translate(CharSequence input, int index, Writer out) throws IOException {<a name="line.277"></a>
<FONT color="green">278</FONT>    <a name="line.278"></a>
<FONT color="green">279</FONT>                if(index != 0) {<a name="line.279"></a>
<FONT color="green">280</FONT>                    throw new IllegalStateException("CsvUnescaper should never reach the [1] index");<a name="line.280"></a>
<FONT color="green">281</FONT>                }<a name="line.281"></a>
<FONT color="green">282</FONT>    <a name="line.282"></a>
<FONT color="green">283</FONT>                if ( input.charAt(0) != CSV_QUOTE || input.charAt(input.length() - 1) != CSV_QUOTE ) {<a name="line.283"></a>
<FONT color="green">284</FONT>                    out.write(input.toString());<a name="line.284"></a>
<FONT color="green">285</FONT>                    return input.length();<a name="line.285"></a>
<FONT color="green">286</FONT>                }<a name="line.286"></a>
<FONT color="green">287</FONT>    <a name="line.287"></a>
<FONT color="green">288</FONT>                // strip quotes<a name="line.288"></a>
<FONT color="green">289</FONT>                String quoteless = input.subSequence(1, input.length() - 1).toString();<a name="line.289"></a>
<FONT color="green">290</FONT>    <a name="line.290"></a>
<FONT color="green">291</FONT>                if ( StringUtils.containsAny(quoteless, CSV_SEARCH_CHARS) ) {<a name="line.291"></a>
<FONT color="green">292</FONT>                    // deal with escaped quotes; ie) ""<a name="line.292"></a>
<FONT color="green">293</FONT>                    out.write(StringUtils.replace(quoteless, CSV_QUOTE_STR + CSV_QUOTE_STR, CSV_QUOTE_STR));<a name="line.293"></a>
<FONT color="green">294</FONT>                } else {<a name="line.294"></a>
<FONT color="green">295</FONT>                    out.write(input.toString());<a name="line.295"></a>
<FONT color="green">296</FONT>                }<a name="line.296"></a>
<FONT color="green">297</FONT>                return input.length();<a name="line.297"></a>
<FONT color="green">298</FONT>            }<a name="line.298"></a>
<FONT color="green">299</FONT>        }<a name="line.299"></a>
<FONT color="green">300</FONT>    <a name="line.300"></a>
<FONT color="green">301</FONT>        /* Helper functions */<a name="line.301"></a>
<FONT color="green">302</FONT>    <a name="line.302"></a>
<FONT color="green">303</FONT>        /**<a name="line.303"></a>
<FONT color="green">304</FONT>         * &lt;p&gt;{@code StringEscapeUtils} instances should NOT be constructed in<a name="line.304"></a>
<FONT color="green">305</FONT>         * standard programming.&lt;/p&gt;<a name="line.305"></a>
<FONT color="green">306</FONT>         *<a name="line.306"></a>
<FONT color="green">307</FONT>         * &lt;p&gt;Instead, the class should be used as:<a name="line.307"></a>
<FONT color="green">308</FONT>         * &lt;pre&gt;StringEscapeUtils.escapeJava("foo");&lt;/pre&gt;&lt;/p&gt;<a name="line.308"></a>
<FONT color="green">309</FONT>         *<a name="line.309"></a>
<FONT color="green">310</FONT>         * &lt;p&gt;This constructor is public to permit tools that require a JavaBean<a name="line.310"></a>
<FONT color="green">311</FONT>         * instance to operate.&lt;/p&gt;<a name="line.311"></a>
<FONT color="green">312</FONT>         */<a name="line.312"></a>
<FONT color="green">313</FONT>        public StringEscapeUtils() {<a name="line.313"></a>
<FONT color="green">314</FONT>          super();<a name="line.314"></a>
<FONT color="green">315</FONT>        }<a name="line.315"></a>
<FONT color="green">316</FONT>    <a name="line.316"></a>
<FONT color="green">317</FONT>        // Java and JavaScript<a name="line.317"></a>
<FONT color="green">318</FONT>        //--------------------------------------------------------------------------<a name="line.318"></a>
<FONT color="green">319</FONT>        /**<a name="line.319"></a>
<FONT color="green">320</FONT>         * &lt;p&gt;Escapes the characters in a {@code String} using Java String rules.&lt;/p&gt;<a name="line.320"></a>
<FONT color="green">321</FONT>         *<a name="line.321"></a>
<FONT color="green">322</FONT>         * &lt;p&gt;Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.) &lt;/p&gt;<a name="line.322"></a>
<FONT color="green">323</FONT>         *<a name="line.323"></a>
<FONT color="green">324</FONT>         * &lt;p&gt;So a tab becomes the characters {@code '\\'} and<a name="line.324"></a>
<FONT color="green">325</FONT>         * {@code 't'}.&lt;/p&gt;<a name="line.325"></a>
<FONT color="green">326</FONT>         *<a name="line.326"></a>
<FONT color="green">327</FONT>         * &lt;p&gt;The only difference between Java strings and JavaScript strings<a name="line.327"></a>
<FONT color="green">328</FONT>         * is that in JavaScript, a single quote and forward-slash (/) are escaped.&lt;/p&gt;<a name="line.328"></a>
<FONT color="green">329</FONT>         *<a name="line.329"></a>
<FONT color="green">330</FONT>         * &lt;p&gt;Example:<a name="line.330"></a>
<FONT color="green">331</FONT>         * &lt;pre&gt;<a name="line.331"></a>
<FONT color="green">332</FONT>         * input string: He didn't say, "Stop!"<a name="line.332"></a>
<FONT color="green">333</FONT>         * output string: He didn't say, \"Stop!\"<a name="line.333"></a>
<FONT color="green">334</FONT>         * &lt;/pre&gt;<a name="line.334"></a>
<FONT color="green">335</FONT>         * &lt;/p&gt;<a name="line.335"></a>
<FONT color="green">336</FONT>         *<a name="line.336"></a>
<FONT color="green">337</FONT>         * @param input  String to escape values in, may be null<a name="line.337"></a>
<FONT color="green">338</FONT>         * @return String with escaped values, {@code null} if null string input<a name="line.338"></a>
<FONT color="green">339</FONT>         */<a name="line.339"></a>
<FONT color="green">340</FONT>        public static final String escapeJava(String input) {<a name="line.340"></a>
<FONT color="green">341</FONT>            return ESCAPE_JAVA.translate(input);<a name="line.341"></a>
<FONT color="green">342</FONT>        }<a name="line.342"></a>
<FONT color="green">343</FONT>    <a name="line.343"></a>
<FONT color="green">344</FONT>        /**<a name="line.344"></a>
<FONT color="green">345</FONT>         * &lt;p&gt;Escapes the characters in a {@code String} using EcmaScript String rules.&lt;/p&gt;<a name="line.345"></a>
<FONT color="green">346</FONT>         * &lt;p&gt;Escapes any values it finds into their EcmaScript String form.<a name="line.346"></a>
<FONT color="green">347</FONT>         * Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.) &lt;/p&gt;<a name="line.347"></a>
<FONT color="green">348</FONT>         *<a name="line.348"></a>
<FONT color="green">349</FONT>         * &lt;p&gt;So a tab becomes the characters {@code '\\'} and<a name="line.349"></a>
<FONT color="green">350</FONT>         * {@code 't'}.&lt;/p&gt;<a name="line.350"></a>
<FONT color="green">351</FONT>         *<a name="line.351"></a>
<FONT color="green">352</FONT>         * &lt;p&gt;The only difference between Java strings and EcmaScript strings<a name="line.352"></a>
<FONT color="green">353</FONT>         * is that in EcmaScript, a single quote and forward-slash (/) are escaped.&lt;/p&gt;<a name="line.353"></a>
<FONT color="green">354</FONT>         *<a name="line.354"></a>
<FONT color="green">355</FONT>         * &lt;p&gt;Note that EcmaScript is best known by the JavaScript and ActionScript dialects. &lt;/p&gt;<a name="line.355"></a>
<FONT color="green">356</FONT>         *<a name="line.356"></a>
<FONT color="green">357</FONT>         * &lt;p&gt;Example:<a name="line.357"></a>
<FONT color="green">358</FONT>         * &lt;pre&gt;<a name="line.358"></a>
<FONT color="green">359</FONT>         * input string: He didn't say, "Stop!"<a name="line.359"></a>
<FONT color="green">360</FONT>         * output string: He didn\'t say, \"Stop!\"<a name="line.360"></a>
<FONT color="green">361</FONT>         * &lt;/pre&gt;<a name="line.361"></a>
<FONT color="green">362</FONT>         * &lt;/p&gt;<a name="line.362"></a>
<FONT color="green">363</FONT>         *<a name="line.363"></a>
<FONT color="green">364</FONT>         * @param input  String to escape values in, may be null<a name="line.364"></a>
<FONT color="green">365</FONT>         * @return String with escaped values, {@code null} if null string input<a name="line.365"></a>
<FONT color="green">366</FONT>         *<a name="line.366"></a>
<FONT color="green">367</FONT>         * @since 3.0<a name="line.367"></a>
<FONT color="green">368</FONT>         */<a name="line.368"></a>
<FONT color="green">369</FONT>        public static final String escapeEcmaScript(String input) {<a name="line.369"></a>
<FONT color="green">370</FONT>            return ESCAPE_ECMASCRIPT.translate(input);<a name="line.370"></a>
<FONT color="green">371</FONT>        }<a name="line.371"></a>
<FONT color="green">372</FONT>    <a name="line.372"></a>
<FONT color="green">373</FONT>        /**<a name="line.373"></a>
<FONT color="green">374</FONT>         * &lt;p&gt;Unescapes any Java literals found in the {@code String}.<a name="line.374"></a>
<FONT color="green">375</FONT>         * For example, it will turn a sequence of {@code '\'} and<a name="line.375"></a>
<FONT color="green">376</FONT>         * {@code 'n'} into a newline character, unless the {@code '\'}<a name="line.376"></a>
<FONT color="green">377</FONT>         * is preceded by another {@code '\'}.&lt;/p&gt;<a name="line.377"></a>
<FONT color="green">378</FONT>         * <a name="line.378"></a>
<FONT color="green">379</FONT>         * @param input  the {@code String} to unescape, may be null<a name="line.379"></a>
<FONT color="green">380</FONT>         * @return a new unescaped {@code String}, {@code null} if null string input<a name="line.380"></a>
<FONT color="green">381</FONT>         */<a name="line.381"></a>
<FONT color="green">382</FONT>        public static final String unescapeJava(String input) {<a name="line.382"></a>
<FONT color="green">383</FONT>            return UNESCAPE_JAVA.translate(input);<a name="line.383"></a>
<FONT color="green">384</FONT>        }<a name="line.384"></a>
<FONT color="green">385</FONT>    <a name="line.385"></a>
<FONT color="green">386</FONT>        /**<a name="line.386"></a>
<FONT color="green">387</FONT>         * &lt;p&gt;Unescapes any EcmaScript literals found in the {@code String}.&lt;/p&gt;<a name="line.387"></a>
<FONT color="green">388</FONT>         *<a name="line.388"></a>
<FONT color="green">389</FONT>         * &lt;p&gt;For example, it will turn a sequence of {@code '\'} and {@code 'n'}<a name="line.389"></a>
<FONT color="green">390</FONT>         * into a newline character, unless the {@code '\'} is preceded by another<a name="line.390"></a>
<FONT color="green">391</FONT>         * {@code '\'}.&lt;/p&gt;<a name="line.391"></a>
<FONT color="green">392</FONT>         *<a name="line.392"></a>
<FONT color="green">393</FONT>         * @see #unescapeJava(String)<a name="line.393"></a>
<FONT color="green">394</FONT>         * @param input  the {@code String} to unescape, may be null<a name="line.394"></a>
<FONT color="green">395</FONT>         * @return A new unescaped {@code String}, {@code null} if null string input<a name="line.395"></a>
<FONT color="green">396</FONT>         *<a name="line.396"></a>
<FONT color="green">397</FONT>         * @since 3.0<a name="line.397"></a>
<FONT color="green">398</FONT>         */<a name="line.398"></a>
<FONT color="green">399</FONT>        public static final String unescapeEcmaScript(String input) {<a name="line.399"></a>
<FONT color="green">400</FONT>            return UNESCAPE_ECMASCRIPT.translate(input);<a name="line.400"></a>
<FONT color="green">401</FONT>        }<a name="line.401"></a>
<FONT color="green">402</FONT>    <a name="line.402"></a>
<FONT color="green">403</FONT>        // HTML and XML<a name="line.403"></a>
<FONT color="green">404</FONT>        //--------------------------------------------------------------------------<a name="line.404"></a>
<FONT color="green">405</FONT>        /**<a name="line.405"></a>
<FONT color="green">406</FONT>         * &lt;p&gt;Escapes the characters in a {@code String} using HTML entities.&lt;/p&gt;<a name="line.406"></a>
<FONT color="green">407</FONT>         *<a name="line.407"></a>
<FONT color="green">408</FONT>         * &lt;p&gt;<a name="line.408"></a>
<FONT color="green">409</FONT>         * For example:<a name="line.409"></a>
<FONT color="green">410</FONT>         * &lt;/p&gt; <a name="line.410"></a>
<FONT color="green">411</FONT>         * &lt;p&gt;&lt;code&gt;"bread" &amp; "butter"&lt;/code&gt;&lt;/p&gt;<a name="line.411"></a>
<FONT color="green">412</FONT>         * becomes:<a name="line.412"></a>
<FONT color="green">413</FONT>         * &lt;p&gt;<a name="line.413"></a>
<FONT color="green">414</FONT>         * &lt;code&gt;&amp;amp;quot;bread&amp;amp;quot; &amp;amp;amp; &amp;amp;quot;butter&amp;amp;quot;&lt;/code&gt;.<a name="line.414"></a>
<FONT color="green">415</FONT>         * &lt;/p&gt;<a name="line.415"></a>
<FONT color="green">416</FONT>         *<a name="line.416"></a>
<FONT color="green">417</FONT>         * &lt;p&gt;Supports all known HTML 4.0 entities, including funky accents.<a name="line.417"></a>
<FONT color="green">418</FONT>         * Note that the commonly used apostrophe escape character (&amp;amp;apos;)<a name="line.418"></a>
<FONT color="green">419</FONT>         * is not a legal entity and so is not supported). &lt;/p&gt;<a name="line.419"></a>
<FONT color="green">420</FONT>         *<a name="line.420"></a>
<FONT color="green">421</FONT>         * @param input  the {@code String} to escape, may be null<a name="line.421"></a>
<FONT color="green">422</FONT>         * @return a new escaped {@code String}, {@code null} if null string input<a name="line.422"></a>
<FONT color="green">423</FONT>         * <a name="line.423"></a>
<FONT color="green">424</FONT>         * @see &lt;a href="http://hotwired.lycos.com/webmonkey/reference/special_characters/"&gt;ISO Entities&lt;/a&gt;<a name="line.424"></a>
<FONT color="green">425</FONT>         * @see &lt;a href="http://www.w3.org/TR/REC-html32#latin1"&gt;HTML 3.2 Character Entities for ISO Latin-1&lt;/a&gt;<a name="line.425"></a>
<FONT color="green">426</FONT>         * @see &lt;a href="http://www.w3.org/TR/REC-html40/sgml/entities.html"&gt;HTML 4.0 Character entity references&lt;/a&gt;<a name="line.426"></a>
<FONT color="green">427</FONT>         * @see &lt;a href="http://www.w3.org/TR/html401/charset.html#h-5.3"&gt;HTML 4.01 Character References&lt;/a&gt;<a name="line.427"></a>
<FONT color="green">428</FONT>         * @see &lt;a href="http://www.w3.org/TR/html401/charset.html#code-position"&gt;HTML 4.01 Code positions&lt;/a&gt;<a name="line.428"></a>
<FONT color="green">429</FONT>         * <a name="line.429"></a>
<FONT color="green">430</FONT>         * @since 3.0<a name="line.430"></a>
<FONT color="green">431</FONT>         */<a name="line.431"></a>
<FONT color="green">432</FONT>        public static final String escapeHtml4(String input) {<a name="line.432"></a>
<FONT color="green">433</FONT>            return ESCAPE_HTML4.translate(input);<a name="line.433"></a>
<FONT color="green">434</FONT>        }<a name="line.434"></a>
<FONT color="green">435</FONT>    <a name="line.435"></a>
<FONT color="green">436</FONT>        /**<a name="line.436"></a>
<FONT color="green">437</FONT>         * &lt;p&gt;Escapes the characters in a {@code String} using HTML entities.&lt;/p&gt;<a name="line.437"></a>
<FONT color="green">438</FONT>         * &lt;p&gt;Supports only the HTML 3.0 entities. &lt;/p&gt;<a name="line.438"></a>
<FONT color="green">439</FONT>         *<a name="line.439"></a>
<FONT color="green">440</FONT>         * @param input  the {@code String} to escape, may be null<a name="line.440"></a>
<FONT color="green">441</FONT>         * @return a new escaped {@code String}, {@code null} if null string input<a name="line.441"></a>
<FONT color="green">442</FONT>         * <a name="line.442"></a>
<FONT color="green">443</FONT>         * @since 3.0<a name="line.443"></a>
<FONT color="green">444</FONT>         */<a name="line.444"></a>
<FONT color="green">445</FONT>        public static final String escapeHtml3(String input) {<a name="line.445"></a>
<FONT color="green">446</FONT>            return ESCAPE_HTML3.translate(input);<a name="line.446"></a>
<FONT color="green">447</FONT>        }<a name="line.447"></a>
<FONT color="green">448</FONT>                    <a name="line.448"></a>
<FONT color="green">449</FONT>        //-----------------------------------------------------------------------<a name="line.449"></a>
<FONT color="green">450</FONT>        /**<a name="line.450"></a>
<FONT color="green">451</FONT>         * &lt;p&gt;Unescapes a string containing entity escapes to a string<a name="line.451"></a>
<FONT color="green">452</FONT>         * containing the actual Unicode characters corresponding to the<a name="line.452"></a>
<FONT color="green">453</FONT>         * escapes. Supports HTML 4.0 entities.&lt;/p&gt;<a name="line.453"></a>
<FONT color="green">454</FONT>         *<a name="line.454"></a>
<FONT color="green">455</FONT>         * &lt;p&gt;For example, the string "&amp;amp;lt;Fran&amp;amp;ccedil;ais&amp;amp;gt;"<a name="line.455"></a>
<FONT color="green">456</FONT>         * will become "&amp;lt;Fran&amp;ccedil;ais&amp;gt;"&lt;/p&gt;<a name="line.456"></a>
<FONT color="green">457</FONT>         *<a name="line.457"></a>
<FONT color="green">458</FONT>         * &lt;p&gt;If an entity is unrecognized, it is left alone, and inserted<a name="line.458"></a>
<FONT color="green">459</FONT>         * verbatim into the result string. e.g. "&amp;amp;gt;&amp;amp;zzzz;x" will<a name="line.459"></a>
<FONT color="green">460</FONT>         * become "&amp;gt;&amp;amp;zzzz;x".&lt;/p&gt;<a name="line.460"></a>
<FONT color="green">461</FONT>         *<a name="line.461"></a>
<FONT color="green">462</FONT>         * @param input  the {@code String} to unescape, may be null<a name="line.462"></a>
<FONT color="green">463</FONT>         * @return a new unescaped {@code String}, {@code null} if null string input<a name="line.463"></a>
<FONT color="green">464</FONT>         * <a name="line.464"></a>
<FONT color="green">465</FONT>         * @since 3.0<a name="line.465"></a>
<FONT color="green">466</FONT>         */<a name="line.466"></a>
<FONT color="green">467</FONT>        public static final String unescapeHtml4(String input) {<a name="line.467"></a>
<FONT color="green">468</FONT>            return UNESCAPE_HTML4.translate(input);<a name="line.468"></a>
<FONT color="green">469</FONT>        }<a name="line.469"></a>
<FONT color="green">470</FONT>    <a name="line.470"></a>
<FONT color="green">471</FONT>        /**<a name="line.471"></a>
<FONT color="green">472</FONT>         * &lt;p&gt;Unescapes a string containing entity escapes to a string<a name="line.472"></a>
<FONT color="green">473</FONT>         * containing the actual Unicode characters corresponding to the<a name="line.473"></a>
<FONT color="green">474</FONT>         * escapes. Supports only HTML 3.0 entities.&lt;/p&gt;<a name="line.474"></a>
<FONT color="green">475</FONT>         *<a name="line.475"></a>
<FONT color="green">476</FONT>         * @param input  the {@code String} to unescape, may be null<a name="line.476"></a>
<FONT color="green">477</FONT>         * @return a new unescaped {@code String}, {@code null} if null string input<a name="line.477"></a>
<FONT color="green">478</FONT>         * <a name="line.478"></a>
<FONT color="green">479</FONT>         * @since 3.0<a name="line.479"></a>
<FONT color="green">480</FONT>         */<a name="line.480"></a>
<FONT color="green">481</FONT>        public static final String unescapeHtml3(String input) {<a name="line.481"></a>
<FONT color="green">482</FONT>            return UNESCAPE_HTML3.translate(input);<a name="line.482"></a>
<FONT color="green">483</FONT>        }<a name="line.483"></a>
<FONT color="green">484</FONT>    <a name="line.484"></a>
<FONT color="green">485</FONT>        //-----------------------------------------------------------------------<a name="line.485"></a>
<FONT color="green">486</FONT>        /**<a name="line.486"></a>
<FONT color="green">487</FONT>         * &lt;p&gt;Escapes the characters in a {@code String} using XML entities.&lt;/p&gt;<a name="line.487"></a>
<FONT color="green">488</FONT>         *<a name="line.488"></a>
<FONT color="green">489</FONT>         * &lt;p&gt;For example: &lt;tt&gt;"bread" &amp; "butter"&lt;/tt&gt; =&gt;<a name="line.489"></a>
<FONT color="green">490</FONT>         * &lt;tt&gt;&amp;amp;quot;bread&amp;amp;quot; &amp;amp;amp; &amp;amp;quot;butter&amp;amp;quot;&lt;/tt&gt;.<a name="line.490"></a>
<FONT color="green">491</FONT>         * &lt;/p&gt;<a name="line.491"></a>
<FONT color="green">492</FONT>         *<a name="line.492"></a>
<FONT color="green">493</FONT>         * &lt;p&gt;Supports only the five basic XML entities (gt, lt, quot, amp, apos).<a name="line.493"></a>
<FONT color="green">494</FONT>         * Does not support DTDs or external entities.&lt;/p&gt;<a name="line.494"></a>
<FONT color="green">495</FONT>         *<a name="line.495"></a>
<FONT color="green">496</FONT>         * &lt;p&gt;Note that Unicode characters greater than 0x7f are as of 3.0, no longer <a name="line.496"></a>
<FONT color="green">497</FONT>         *    escaped. If you still wish this functionality, you can achieve it <a name="line.497"></a>
<FONT color="green">498</FONT>         *    via the following: <a name="line.498"></a>
<FONT color="green">499</FONT>         * {@code StringEscapeUtils.ESCAPE_XML.with( NumericEntityEscaper.between(0x7f, Integer.MAX_VALUE) );}&lt;/p&gt;<a name="line.499"></a>
<FONT color="green">500</FONT>         *<a name="line.500"></a>
<FONT color="green">501</FONT>         * @param input  the {@code String} to escape, may be null<a name="line.501"></a>
<FONT color="green">502</FONT>         * @return a new escaped {@code String}, {@code null} if null string input<a name="line.502"></a>
<FONT color="green">503</FONT>         * @see #unescapeXml(java.lang.String)<a name="line.503"></a>
<FONT color="green">504</FONT>         */<a name="line.504"></a>
<FONT color="green">505</FONT>        public static final String escapeXml(String input) {<a name="line.505"></a>
<FONT color="green">506</FONT>            return ESCAPE_XML.translate(input);<a name="line.506"></a>
<FONT color="green">507</FONT>        }<a name="line.507"></a>
<FONT color="green">508</FONT>                    <a name="line.508"></a>
<FONT color="green">509</FONT>    <a name="line.509"></a>
<FONT color="green">510</FONT>        //-----------------------------------------------------------------------<a name="line.510"></a>
<FONT color="green">511</FONT>        /**<a name="line.511"></a>
<FONT color="green">512</FONT>         * &lt;p&gt;Unescapes a string containing XML entity escapes to a string<a name="line.512"></a>
<FONT color="green">513</FONT>         * containing the actual Unicode characters corresponding to the<a name="line.513"></a>
<FONT color="green">514</FONT>         * escapes.&lt;/p&gt;<a name="line.514"></a>
<FONT color="green">515</FONT>         *<a name="line.515"></a>
<FONT color="green">516</FONT>         * &lt;p&gt;Supports only the five basic XML entities (gt, lt, quot, amp, apos).<a name="line.516"></a>
<FONT color="green">517</FONT>         * Does not support DTDs or external entities.&lt;/p&gt;<a name="line.517"></a>
<FONT color="green">518</FONT>         *<a name="line.518"></a>
<FONT color="green">519</FONT>         * &lt;p&gt;Note that numerical \\u Unicode codes are unescaped to their respective <a name="line.519"></a>
<FONT color="green">520</FONT>         *    Unicode characters. This may change in future releases. &lt;/p&gt;<a name="line.520"></a>
<FONT color="green">521</FONT>         *<a name="line.521"></a>
<FONT color="green">522</FONT>         * @param input  the {@code String} to unescape, may be null<a name="line.522"></a>
<FONT color="green">523</FONT>         * @return a new unescaped {@code String}, {@code null} if null string input<a name="line.523"></a>
<FONT color="green">524</FONT>         * @see #escapeXml(String)<a name="line.524"></a>
<FONT color="green">525</FONT>         */<a name="line.525"></a>
<FONT color="green">526</FONT>        public static final String unescapeXml(String input) {<a name="line.526"></a>
<FONT color="green">527</FONT>            return UNESCAPE_XML.translate(input);<a name="line.527"></a>
<FONT color="green">528</FONT>        }<a name="line.528"></a>
<FONT color="green">529</FONT>                    <a name="line.529"></a>
<FONT color="green">530</FONT>    <a name="line.530"></a>
<FONT color="green">531</FONT>        //-----------------------------------------------------------------------<a name="line.531"></a>
<FONT color="green">532</FONT>    <a name="line.532"></a>
<FONT color="green">533</FONT>        /**<a name="line.533"></a>
<FONT color="green">534</FONT>         * &lt;p&gt;Returns a {@code String} value for a CSV column enclosed in double quotes,<a name="line.534"></a>
<FONT color="green">535</FONT>         * if required.&lt;/p&gt;<a name="line.535"></a>
<FONT color="green">536</FONT>         *<a name="line.536"></a>
<FONT color="green">537</FONT>         * &lt;p&gt;If the value contains a comma, newline or double quote, then the<a name="line.537"></a>
<FONT color="green">538</FONT>         *    String value is returned enclosed in double quotes.&lt;/p&gt;<a name="line.538"></a>
<FONT color="green">539</FONT>         * &lt;/p&gt;<a name="line.539"></a>
<FONT color="green">540</FONT>         *<a name="line.540"></a>
<FONT color="green">541</FONT>         * &lt;p&gt;Any double quote characters in the value are escaped with another double quote.&lt;/p&gt;<a name="line.541"></a>
<FONT color="green">542</FONT>         *<a name="line.542"></a>
<FONT color="green">543</FONT>         * &lt;p&gt;If the value does not contain a comma, newline or double quote, then the<a name="line.543"></a>
<FONT color="green">544</FONT>         *    String value is returned unchanged.&lt;/p&gt;<a name="line.544"></a>
<FONT color="green">545</FONT>         * &lt;/p&gt;<a name="line.545"></a>
<FONT color="green">546</FONT>         *<a name="line.546"></a>
<FONT color="green">547</FONT>         * see &lt;a href="http://en.wikipedia.org/wiki/Comma-separated_values"&gt;Wikipedia&lt;/a&gt; and<a name="line.547"></a>
<FONT color="green">548</FONT>         * &lt;a href="http://tools.ietf.org/html/rfc4180"&gt;RFC 4180&lt;/a&gt;.<a name="line.548"></a>
<FONT color="green">549</FONT>         *<a name="line.549"></a>
<FONT color="green">550</FONT>         * @param input the input CSV column String, may be null<a name="line.550"></a>
<FONT color="green">551</FONT>         * @return the input String, enclosed in double quotes if the value contains a comma,<a name="line.551"></a>
<FONT color="green">552</FONT>         * newline or double quote, {@code null} if null string input<a name="line.552"></a>
<FONT color="green">553</FONT>         * @since 2.4<a name="line.553"></a>
<FONT color="green">554</FONT>         */<a name="line.554"></a>
<FONT color="green">555</FONT>        public static final String escapeCsv(String input) {<a name="line.555"></a>
<FONT color="green">556</FONT>            return ESCAPE_CSV.translate(input);<a name="line.556"></a>
<FONT color="green">557</FONT>        }<a name="line.557"></a>
<FONT color="green">558</FONT>    <a name="line.558"></a>
<FONT color="green">559</FONT>        /**<a name="line.559"></a>
<FONT color="green">560</FONT>         * &lt;p&gt;Returns a {@code String} value for an unescaped CSV column. &lt;/p&gt;<a name="line.560"></a>
<FONT color="green">561</FONT>         *<a name="line.561"></a>
<FONT color="green">562</FONT>         * &lt;p&gt;If the value is enclosed in double quotes, and contains a comma, newline <a name="line.562"></a>
<FONT color="green">563</FONT>         *    or double quote, then quotes are removed. <a name="line.563"></a>
<FONT color="green">564</FONT>         * &lt;/p&gt;<a name="line.564"></a>
<FONT color="green">565</FONT>         *<a name="line.565"></a>
<FONT color="green">566</FONT>         * &lt;p&gt;Any double quote escaped characters (a pair of double quotes) are unescaped <a name="line.566"></a>
<FONT color="green">567</FONT>         *    to just one double quote. &lt;/p&gt;<a name="line.567"></a>
<FONT color="green">568</FONT>         *<a name="line.568"></a>
<FONT color="green">569</FONT>         * &lt;p&gt;If the value is not enclosed in double quotes, or is and does not contain a <a name="line.569"></a>
<FONT color="green">570</FONT>         *    comma, newline or double quote, then the String value is returned unchanged.&lt;/p&gt;<a name="line.570"></a>
<FONT color="green">571</FONT>         * &lt;/p&gt;<a name="line.571"></a>
<FONT color="green">572</FONT>         *<a name="line.572"></a>
<FONT color="green">573</FONT>         * see &lt;a href="http://en.wikipedia.org/wiki/Comma-separated_values"&gt;Wikipedia&lt;/a&gt; and<a name="line.573"></a>
<FONT color="green">574</FONT>         * &lt;a href="http://tools.ietf.org/html/rfc4180"&gt;RFC 4180&lt;/a&gt;.<a name="line.574"></a>
<FONT color="green">575</FONT>         *<a name="line.575"></a>
<FONT color="green">576</FONT>         * @param input the input CSV column String, may be null<a name="line.576"></a>
<FONT color="green">577</FONT>         * @return the input String, with enclosing double quotes removed and embedded double <a name="line.577"></a>
<FONT color="green">578</FONT>         * quotes unescaped, {@code null} if null string input<a name="line.578"></a>
<FONT color="green">579</FONT>         * @since 2.4<a name="line.579"></a>
<FONT color="green">580</FONT>         */<a name="line.580"></a>
<FONT color="green">581</FONT>        public static final String unescapeCsv(String input) {<a name="line.581"></a>
<FONT color="green">582</FONT>            return UNESCAPE_CSV.translate(input);<a name="line.582"></a>
<FONT color="green">583</FONT>        }<a name="line.583"></a>
<FONT color="green">584</FONT>    <a name="line.584"></a>
<FONT color="green">585</FONT>    }<a name="line.585"></a>




























































</PRE>
</BODY>
</HTML>
